Create org-wide contributing guide (#148)#240
Open
anish-devgit wants to merge 1 commit intoaboutcode-org:mainfrom
Open
Create org-wide contributing guide (#148)#240anish-devgit wants to merge 1 commit intoaboutcode-org:mainfrom
anish-devgit wants to merge 1 commit intoaboutcode-org:mainfrom
Conversation
- Created comprehensive CONTRIBUTING.md in repository root - Consolidates best practices from VulnerableCode, ScanCode.io, and DejaCode - Follows OmniBOR's simple, accessible design pattern - Emphasizes small PRs and code style matching - References issue referencing guidelines from aboutcode-org#106 - Links to existing detailed guides (commit messages, docs) - Updated contributing.rst to prominently link to new guide This provides a single source of truth for contributing across all AboutCode projects while preserving project-specific documentation. Fixes aboutcode-org#148 Signed-off-by: Anish <anishkumar@example.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #148
Creates a comprehensive, org-wide CONTRIBUTING.md that consolidates best practices from all AboutCode projects into a single, accessible guide.
Changes Made
CONTRIBUTING.mdin repository root (Markdown format for GitHub visibility)docs/source/contributing.rst- added prominent reference to new guideKey Features
Content Sources
Benefits
✅ Single source of truth for all AboutCode contributions
✅ More accessible than scattered RST documentation
✅ Top-level GitHub visibility (CONTRIBUTING.md auto-linked)
✅ Preserves project-specific guides via links
✅ Emphasizes small PRs and matching existing code style